Skip to content

docs: update docs for new lti ui#1439

Open
rpenido wants to merge 3 commits intoopenedx:mainfrom
open-craft:rpenido/fal-4323/update-lti-docs
Open

docs: update docs for new lti ui#1439
rpenido wants to merge 3 commits intoopenedx:mainfrom
open-craft:rpenido/fal-4323/update-lti-docs

Conversation

@rpenido
Copy link
Copy Markdown

@rpenido rpenido commented Apr 30, 2026

This PR updates the LTI Consumer block documentation with the new UI and field names.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 30, 2026
@openedx-webhooks
Copy link
Copy Markdown

openedx-webhooks commented Apr 30, 2026

Thanks for the pull request, @rpenido!

This repository is currently maintained by @openedx/wg-maintenance-docs.openedx.org.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Apr 30, 2026
@rpenido rpenido force-pushed the rpenido/fal-4323/update-lti-docs branch from d3e4b44 to 190851b Compare May 5, 2026 18:02
@rpenido rpenido force-pushed the rpenido/fal-4323/update-lti-docs branch from 190851b to a0a3f3d Compare May 5, 2026 18:21
@navinkarkera
Copy link
Copy Markdown

@rpenido I pushed a commit to fix typos and spacing issue in table, lets see if the CI passes now.

@sarina
Copy link
Copy Markdown
Contributor

sarina commented May 6, 2026

@rpenido @navinkarkera - please ping me for review when this is out of draft!

@rpenido rpenido marked this pull request as ready for review May 6, 2026 21:42
@rpenido
Copy link
Copy Markdown
Author

rpenido commented May 6, 2026

This is ready for review @sarina!

Copy link
Copy Markdown
Contributor

@sarina sarina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great, thank you.

If these documents have been reviewed & are accurate, please update the maintenance chart - https://docs.openedx.org/en/latest/documentors/references/doc_maintenance.html#maintenance-chart - if there are docs in this diff that have not been reviewed for accuracy... could they be? So that we have reviewed docs for Verawood. Thank you!

@mphilbrick211 mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions May 7, 2026
@rpenido rpenido force-pushed the rpenido/fal-4323/update-lti-docs branch from 73f0434 to 20d53e3 Compare May 7, 2026 14:08
Co-authored-by: Sarina Canelake <sarina@axim.org>
@rpenido rpenido force-pushed the rpenido/fal-4323/update-lti-docs branch from 20d53e3 to 04fba0a Compare May 7, 2026 14:09
Copy link
Copy Markdown

@musaabhasan musaabhasan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The updated LTI field names are helpful for keeping the docs aligned with the current Studio UI. I left one privacy wording note around the data-sharing notice so educators do not confuse a disclosure field with the actual controls that determine whether learner identifiers are shared.

identify problems quickly and accurately for analysis.

* - LTI Application Information
* - Data Sharing Notice
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would help to clarify that this field is a learner-facing disclosure, not the control that enables or disables sharing. Since the same table later documents Share Email, Share Username, and Share Full Name, educators could otherwise read this as the setting that determines whether identifiers are sent. A sentence such as "This notice does not control whether data is shared; use the sharing settings below for that behavior" would make the privacy boundary clearer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: In Eng Review

Development

Successfully merging this pull request may close these issues.

6 participants